/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.api.connector.source.lib.util;

import org.apache.flink.api.connector.source.SourceSplit;

import java.util.Iterator;

/**
 * A {@link SourceSplit} that represents a sequence of elements captured in an iterator. The split
 * produces the iterator and converts the iterator back to a new split during checkpointing.
 *
 * @param <E> The type of the elements returned by the iterator.
 */
public interface IteratorSourceSplit<E, IterT extends Iterator<E>> extends SourceSplit {

    /** Gets the iterator over the elements of this split. */
    IterT getIterator();

    /**
     * Converts an iterator (that may have returned some elements already) back into a source split.
     */
    IteratorSourceSplit<E, IterT> getUpdatedSplitForIterator(IterT iterator);
}
